Skip to content

skills: add release_updates automation for release docs updates#171

Open
dannyneira wants to merge 5 commits into
mainfrom
skill/release-updates
Open

skills: add release_updates automation for release docs updates#171
dannyneira wants to merge 5 commits into
mainfrom
skill/release-updates

Conversation

@dannyneira
Copy link
Copy Markdown
Member

@dannyneira dannyneira commented Jun 2, 2026

Summary

Adds a new release_updates skill in the docs repo with standalone scripts for weekly release docs maintenance, including Linux/Oz-compatible Warp artifact preparation.

Changes

  • Added .agents/skills/release_updates/SKILL.md with usage for:
    • default ordered execution of all tasks
    • running selected tasks only (for incremental rollout like changelog-only)
    • local testing and explicit repo path overrides
  • Added standalone scripts under .agents/skills/release_updates/scripts/:
    • update_warp_app.py
    • update_changelog.py
    • update_licenses.py
    • update_telemetry.py
    • run_release_updates.py
    • common.py
  • Implemented task ordering and selection in run_release_updates.py:
    1. warp_app_update
    2. changelog
    3. licenses
    4. telemetry
  • Added auto-detection/fallback behavior for docs + channel-versions inputs to support Oz-dev run environments and local development checkouts.

Validation

  • python3 -m py_compile .agents/skills/release_updates/scripts/common.py .agents/skills/release_updates/scripts/update_warp_app.py .agents/skills/release_updates/scripts/update_changelog.py .agents/skills/release_updates/scripts/update_licenses.py .agents/skills/release_updates/scripts/update_telemetry.py .agents/skills/release_updates/scripts/run_release_updates.py
  • python3 .agents/skills/release_updates/scripts/run_release_updates.py --tasks changelog --dry-run --docs-repo /Users/danny/dx/src/warp_docs
  • python3 .agents/skills/release_updates/scripts/run_release_updates.py --tasks warp_app_update --dry-run
  • python3 .agents/skills/release_updates/scripts/run_release_updates.py --tasks telemetry --telemetry-json-file /Users/danny/dx/src/warp_docs/telemetry.json --dry-run --docs-repo /Users/danny/dx/src/warp_docs
  • End-to-end ordered dry-run with explicit telemetry/licenses inputs

Co-Authored-By: Oz oz-agent@warp.dev

Co-Authored-By: Oz <oz-agent@warp.dev>
@cla-bot cla-bot Bot added the cla-signed label Jun 2, 2026
@vercel
Copy link
Copy Markdown

vercel Bot commented Jun 2, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Jun 3, 2026 5:18pm

Request Review

@oz-for-oss
Copy link
Copy Markdown
Contributor

oz-for-oss Bot commented Jun 2, 2026

@dannyneira

I'm starting a first review of this pull request.

You can view the conversation on Warp.

I completed the review and no human review was requested for this pull request.

Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).

Powered by Oz

Copy link
Copy Markdown
Contributor

@oz-for-oss oz-for-oss Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overview

This PR adds a new release_updates skill with scripts to automate weekly changelog, license, telemetry, and Warp artifact preparation for docs maintenance. I found two correctness issues in the generated workflow: the documented default dry run cannot complete without real artifact sources, and newly-created changelog year files can be populated with entries from every historical year.

Concerns

  • The documented --dry-run all-task command fails once downstream tasks try to read artifact-derived license/telemetry inputs that the dry-run artifact step never creates.
  • The changelog updater does not filter entries to the requested output year when creating a new year file, so a new annual changelog can import older years' releases.

Verdict

Found: 0 critical, 2 important, 0 suggestions

Request changes

Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).

Powered by Oz

Comment thread .agents/skills/release_updates/SKILL.md
Comment thread .agents/skills/release_updates/scripts/update_changelog.py Outdated
@dannyneira dannyneira changed the title skills: add release_updates automation for release docs updates docs: weekly release updates (2026-06-02) Jun 2, 2026
@dannyneira dannyneira self-assigned this Jun 2, 2026
@dannyneira dannyneira closed this Jun 3, 2026
@dannyneira dannyneira reopened this Jun 3, 2026
@oz-for-oss
Copy link
Copy Markdown
Contributor

oz-for-oss Bot commented Jun 3, 2026

@dannyneira

I'm starting a first review of this pull request.

You can view the conversation on Warp.

I completed the review and no human review was requested for this pull request.

Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).

Powered by Oz

Copy link
Copy Markdown
Contributor

@oz-for-oss oz-for-oss Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overview

This PR adds a new release_updates skill and standalone Python scripts for weekly Warp docs maintenance. I reviewed the attached diff and found correctness issues in the changelog year handling and on-call reviewer resolution, plus one PR-artifact hygiene concern.

Concerns

  • Creating a new yearly changelog file can include historical releases from other years because entries are not filtered to the requested year.
  • On-call reviewer fallback matching only reads the first 100 GitHub org members, which can fail for valid on-call users in larger orgs.
  • The telemetry generator defaults an intermediate JSON artifact to the repo root, which can be swept into automated PR commits.

Verdict

Found: 0 critical, 2 important, 1 suggestions

Request changes

Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).

Powered by Oz

Comment thread .agents/skills/release_updates/scripts/update_changelog.py
Comment thread .agents/skills/release_updates/scripts/resolve_oncall_reviewers.py Outdated
Comment thread .agents/skills/release_updates/scripts/update_telemetry.py Outdated
@dannyneira dannyneira changed the title docs: weekly release updates (2026-06-02) skills: add release_updates automation for release docs updates Jun 3, 2026
@dannyneira
Copy link
Copy Markdown
Member Author

/oz-review

@oz-for-oss
Copy link
Copy Markdown
Contributor

oz-for-oss Bot commented Jun 3, 2026

@dannyneira

I'm re-reviewing this pull request in response to a review request.

You can view the conversation on Warp.

I completed the review and no human review was requested for this pull request.

Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).

Powered by Oz

Copy link
Copy Markdown
Contributor

@oz-for-oss oz-for-oss Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overview

This PR adds a new release_updates skill and standalone automation scripts for weekly changelog, license, telemetry, Warp artifact, and PR maintenance. The implementation covers the intended workflow, but I found issues that should be fixed before merge around public exposure of internal reviewer mappings, unsafe rendering of release metadata into MDX, and incomplete changelog year-rollover navigation updates.

Concerns

  • The on-call reviewer resolver commits specific internal email-to-GitHub mappings into the public docs repo.
  • The changelog renderer interpolates network-sourced image_url directly into an HTML attribute, which can generate unsafe MDX if the release metadata is malformed or compromised.
  • New changelog year files update only src/content/docs/changelog/index.mdx; src/sidebar.ts remains hard-coded and will omit the new year from navigation.

Security

  • Avoid committing internal email mappings in repository code; keep overrides in private configuration or derive them from authenticated GitHub/Grafana APIs.
  • Escape or validate release metadata before rendering it into MDX/HTML.

Verdict

Found: 0 critical, 3 important, 0 suggestions

Request changes

Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).

Powered by Oz

Comment thread .agents/skills/release_updates/scripts/resolve_oncall_reviewers.py Outdated
Comment thread .agents/skills/release_updates/scripts/update_changelog.py Outdated
Comment thread .agents/skills/release_updates/scripts/update_changelog.py
Co-Authored-By: Oz <oz-agent@warp.dev>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant